home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Cream of the Crop 20
/
Cream of the Crop 20 (Terry Blount) (1996).iso
/
program
/
nxdv99_3.zip
/
LOGFMT.DOC
< prev
next >
Wrap
Text File
|
1996-06-19
|
6KB
|
190 lines
Nexus (tm) - Next Epoch matriX User System (tm)
Third Party Development Kit
(c) Copyright 1996 Intuitive Vision Software. All Rights Reserved.
------------------------------------------------------------------------------
Nexus Log File Structures : LOGFMT.DOC
Revision Number : 0.99.02
Revision Date : 19 Jun 96
Intuitive Vision Software may be in no way held responsible for inaccuracies
of this document with regard to spelling, content, or any other items. Use
the information contained within at your own risk. This information with
comes with no guarantee of its accuracy or validity.
Table of Contents
i. Overview
ii. Log File Naming Conventions
iii. Log File Format
iv. Accessing the Log Files
v. Conclusion
i. Overview
Nexus and related Intuitive Vision Software products use a common
log file format so as to promote consistancy for the SysOp running Nexus.
Third Party Developers (TPDs) are required to follow this format if writing
DIRECTLY to the Nexus Log Files and are highly encouraged to do so if
writing to their own log file.
ii. Log File Naming Conventions
The Nexus Log Files follow the following naming convention. You
may choose to implement this if writing to your own TPD-specific log file.
Nexus's Log files are named:
NEXxxxx.LOG where xxxx is the node number right-justified and
padded with zeros. (i.e. NEX0001.LOG for Node 1)
iii. Log File Format
The log file is broken into the following 3 type of lines: Beginning
of Day Markers, Beginning of Session Markers, and Log line. Blank
lines may be included in log files and will be assumed to be log lines
as well, though they do not follow the log line format. They will
simply be ignored as fillers.
a. Beginning of Day Markers.
Beginning of Day Markers look like the following:
*** 07/21/95
The *** is a mark that tells Nexus that a new days log has
begun. This is so that Nexus may delete old logs based on
the SysOp's setting in NxSetup. This entry is required in
the Nexus Log Files and is optional in TPD-specific log files.
There should only be ONE occurance of a specific date's
Beginning of Day Marker. Use whatever means necessary to
ensure that this is followed. Nexus stores the last date
logged in a data file and compares the current date (when
starting up) to the last logged date. If different, it
appends a new Beginning of Day Marker.
b. Beginning of Session Marker
Beginning of Session Markers look like the following:
--- Created by Nexus 0.97 Alpha [Node 4] On 07/21/95 17:59:54
There are 2 requirements of the Beginning of Session Marker.
--- Created by
is required.
On 07/21/95 17:59:54
(i.e. "On [Date] [Time]") is also required. What a TPD
chooses to place in between is entirely up to them.
Intuitive Vision Software recommends the Name and Version
of the software creating the log entry.
c. Log Line
Log Lines look like the following:
: 21:57:37 Begin; Nexus 0.97 Alpha
Note the positions of the items. The first item is the
Description Character. This is at position 1. This is a
descriptive character of the type of activity that is
being logged. At this time, Intuitive Vision Software has
not decided on a specific format for the Description
Characters. That is left up to the TPD. Some examples are
listed below:
: Start/End of program
! Error/Extremely Important Information
d Running a Door
$ Statistics/Information
+ Adding Something/Information
- Removing Something/Information
~ System Activity
At position 3 the Time of the Log entry is listed. This
MUST be in 24 hour time format. At position 12 the log line
is listed. The log line itself may be of any length.
There is no restriction on this matter. Any information may
be listed. There may be no Color Codes or ANSI sequences in
the log file.
iv. Accessing the Log Files
Nexus accesses its log files, though they are Text Files, as an
UNTYPED FILE. This allows Nexus to be able to open the file and share it.
This will allow Third Party Utilities to be able to access the Nexus Log
Files at the same time as Nexus. You MUST open the Nexus Log Files with
READ/WRITE DENY NONE. If a TPD is using its own TPD-specific log file, then
that TPD may choose to open the file whichever way serves their purpose best.
When Nexus writes to the log file, it does not keep the log file open. It
opens the file, writes the necessary lines, and closes the file again. This
is to ensure that two programs will not write to the file at the same time,
causing garbled log lines. This COULD happen, but is very unlikely with
this method being employed.
v. Conclusion
Intuitive Vision Software has attempted to set up a unified format
for logging for Nexus and its related software. This is to allow for ease-
of-use for SysOps. It is much easier to read a log file that you are familiar
with the format of, than many different log file formats.
If you have any questions regarding the log file format, please
contact Intuitive Vision Software via the means listed in CONTACT.DOC.
Nexus and Next Epoch matriX User System are Trademarks of Intuitive Vision
Software.
/* End of file LOGFMT.DOC */